Skip to content

break out wsh editor and clarify behavior. also document -m flag...#2988

Merged
sawka merged 2 commits intomainfrom
sawka/update-docs
Mar 6, 2026
Merged

break out wsh editor and clarify behavior. also document -m flag...#2988
sawka merged 2 commits intomainfrom
sawka/update-docs

Conversation

@sawka
Copy link
Member

@sawka sawka commented Mar 5, 2026

fix documentation issue #2948

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 5, 2026 •
edited
Loading

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: d9ea06f9-4ab5-4cf2-838d-d4945659136a

📥 Commits

Reviewing files that changed from the base of the PR and between 8df9913 and 825cdc5.

📒 Files selected for processing (1)
  • docs/docs/wsh-reference.mdx

Walkthrough

Updated documentation in wsh-reference.mdx: added -m (magnified-block) aliases for wsh view and wsh edit; changed wsh edit semantics to open a codeedit block and return immediately; introduced a new wsh editor command (and wsh editor -m) that blocks until the editor closes; added guidance for configuring the EDITOR environment variable and noted files must exist; inserted a separator and examples. Total changes: +22/−1 lines.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately captures the main changes: breaking out wsh editor command, clarifying its behavior, and documenting the -m flag for magnified blocks.
Description check ✅ Passed The description references a documentation issue (#2948) that the PR aims to fix, which is related to the changeset's documentation updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch sawka/update-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@kilo-code-bot
Copy link
Contributor

kilo-code-bot bot commented Mar 5, 2026 •
edited
Loading

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Files Reviewed (1 file)
  • docs/docs/wsh-reference.mdx - Documentation-only changes

Review Notes

This PR adds documentation for:

  • -m (magnified mode) flag for wsh view and wsh edit commands
  • Clarifies that wsh edit returns immediately (non-blocking)
  • New wsh editor command for $EDITOR integration (blocks until closed)

I verified the documentation against the implementation in cmd/wsh/cmd/wshcmd-view.go and cmd/wsh/cmd/wshcmd-editor.go. All commands behave as documented.

Note: An existing comment from CodeRabbit about wording ("until the file is closed" → "until the editor block is closed") was addressed in commit 825cdc5.

coderabbitai[bot]
coderabbitai bot reviewed Mar 5, 2026
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents 
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/docs/wsh-reference.mdx`:
- Line 43: The sentence "blocks until the file is closed" is imprecise; update
the docs entry for `wsh editor` to state that the command blocks until the
editor block is closed (i.e., until the `Event_BlockClose` is received),
matching the implementation in `cmd/wsh/cmd/wshcmd-editor.go` where the code
waits on `Event_BlockClose` (around the wait in lines ~82-89). Mention `wsh
editor` and `Event_BlockClose` explicitly so readers understand the blocking
condition maps to the editor block lifecycle rather than the OS file handle.
ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: fa8abec8-e805-4195-a0be-8e1aedf935fb

📥 Commits

Reviewing files that changed from the base of the PR and between f59fdb5 and 8df9913.

📒 Files selected for processing (1)
  • docs/docs/wsh-reference.mdx

@sawka sawka merged commit ff673e1 into main Mar 6, 2026
3 of 4 checks passed
@sawka sawka deleted the sawka/update-docs branch March 6, 2026 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@sawka